GAO Ballot Package

This page is part of the FHIR Specification (v1.1.0: STU 3 Ballot 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

This is a frozen snapshot of the FHIR specification created for the purpose of balloting the GAO implementation Guide. It includes draft changes that may be part of the future DSTU 2.1 release but further change is expected. Readers should focus solely on the GAO implementation content, and FHIR DSTU 2 for other purposes.

D.23.3.1 StructureDefinition: DAF-Pract

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/daf-pract

DAF Practitioner

This profile was published on Thu, Mar 5, 2015 00:00+1100 as a draft by Health Level Seven International (Infrastructure and Messaging - Data Access Framework).

D.23.3.1.1 Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Practitioner.

Summary

Mandatory: 2 elements (+5 nested mandatory elements)
Must-Support: 16 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

This structure is derived from Practitioner.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I0..*PractitionerDAF Practitioner
inv-1: Shall havePractitioner.name and/or Practitioner.identifier.
... text S1..1Narrative
.... status S1..1codeFixed Value: generated
... identifier S I0..*Identifier
.... system S1..1uriNPI could be used as the identifier system in the US.
Example: NPI could be used as the identifier system in the US.
.... value S1..1string
... name S0..1HumanName
.... family S1..*string
.... given S0..2string
.... prefix S0..1string
.... suffix S0..1string
... telecom S0..*ContactPoint
.... system S1..1code
.... value S1..1string
.... us-core-direct S0..1booleanEmail is a "direct" email
URL: http://hl7.org/fhir/StructureDefinition/us-core-direct
... practitionerRole S0..*BackboneElement
.... managingOrganization S0..1Reference(DAF-Organization)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I0..*PractitionerDAF Practitioner
inv-1: Shall havePractitioner.name and/or Practitioner.identifier.
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text S I1..1NarrativeText summary of the resource, for human interpretation
.... extension 0..*ExtensionAdditional Content defined by implementations
.... status S1..1codegenerated | extensions | additional | empty
Binding: NarrativeStatus (required)
Fixed Value: generated
.... div I1..1xhtmlLimited xhtml content
txt-2: The narrative SHALL have some non-whitespace content
txt-1: The narrative SHALL contain only the basic html formatting elements described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
txt-3: The narrative SHALL contain only the basic html formatting attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S ∑0..*IdentifierA identifier for the person as this agent
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! ∑0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type ∑0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system S ∑1..1uriNPI could be used as the identifier system in the US.
Example: NPI could be used as the identifier system in the US.
.... value S ∑1..1stringThe value that is unique
Example: 123456
.... period ∑0..1PeriodTime period when id is/was valid for use
.... assigner ∑0..1Reference(Organization)Organization that issued id (may be just text)
... active ∑0..1booleanWhether this practitioner's record is in active use
... name S ∑0..1HumanNameA name associated with the person
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! ∑0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
.... text ∑0..1stringText representation of the full name
.... family S ∑1..*stringFamily name (often called 'Surname')
.... given S ∑0..2stringGiven names (not always 'first'). Includes middle names
.... prefix S ∑0..1stringParts that come before the name
.... suffix S ∑0..1stringParts that come after the name
.... period ∑0..1PeriodTime period when name was/is in use
... telecom S ∑0..*ContactPointA contact detail for the practitioner
.... us-core-direct S0..1booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/us-core-direct
.... system S ∑I1..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
.... value S ∑1..1stringThe actual contact point details
.... use ?! ∑0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank ∑0..1positiveIntSpecify preferred order of use (1 = highest)
.... period ∑0..1PeriodTime period when the contact point was/is in use
... address ∑0..*AddressWhere practitioner can be found/visited
... gender ∑0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate ∑0..1dateThe date on which the practitioner was born
... photo 0..*AttachmentImage of the person
... practitionerRole S0..*BackboneElementRoles/organizations the practitioner is associated with
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... managingOrganization S0..1Reference(DAF-Organization)Organization where the roles are performed
.... role ∑0..1CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRole (example)
.... specialty ∑0..*CodeableConceptSpecific specialty of the practitioner
Binding: PractitionerSpecialty (example)
.... period ∑0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
.... location 0..*Reference(Location)The location(s) at which this practitioner provides care
.... healthcareService 0..*Reference(HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... qualification 0..*BackboneElementQualifications obtained by training and certification
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... identifier 0..*IdentifierAn identifier for this qualification for the practitioner
.... code 1..1CodeableConceptCoded representation of the qualification
Binding: ANZSCO -- Australian and New Zealand Standard Classification of Occupations, 2013, Version 1.2 (example)
.... period 0..1PeriodPeriod during which the qualification is valid
.... issuer 0..1Reference(Organization)Organization that regulates and issues the qualification
... communication 0..*CodeableConceptA language the practitioner is able to use in patient communication
Binding: IETF BCP-47 (required)

doco Documentation for this format

todo

This structure is derived from Practitioner.

Summary

Mandatory: 2 elements (+5 nested mandatory elements)
Must-Support: 16 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from Practitioner.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I0..*PractitionerDAF Practitioner
inv-1: Shall havePractitioner.name and/or Practitioner.identifier.
... text S1..1Narrative
.... status S1..1codeFixed Value: generated
... identifier S I0..*Identifier
.... system S1..1uriNPI could be used as the identifier system in the US.
Example: NPI could be used as the identifier system in the US.
.... value S1..1string
... name S0..1HumanName
.... family S1..*string
.... given S0..2string
.... prefix S0..1string
.... suffix S0..1string
... telecom S0..*ContactPoint
.... system S1..1code
.... value S1..1string
.... us-core-direct S0..1booleanEmail is a "direct" email
URL: http://hl7.org/fhir/StructureDefinition/us-core-direct
... practitionerRole S0..*BackboneElement
.... managingOrganization S0..1Reference(DAF-Organization)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I0..*PractitionerDAF Practitioner
inv-1: Shall havePractitioner.name and/or Practitioner.identifier.
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text S I1..1NarrativeText summary of the resource, for human interpretation
.... extension 0..*ExtensionAdditional Content defined by implementations
.... status S1..1codegenerated | extensions | additional | empty
Binding: NarrativeStatus (required)
Fixed Value: generated
.... div I1..1xhtmlLimited xhtml content
txt-2: The narrative SHALL have some non-whitespace content
txt-1: The narrative SHALL contain only the basic html formatting elements described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
txt-3: The narrative SHALL contain only the basic html formatting attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S ∑0..*IdentifierA identifier for the person as this agent
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! ∑0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type ∑0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system S ∑1..1uriNPI could be used as the identifier system in the US.
Example: NPI could be used as the identifier system in the US.
.... value S ∑1..1stringThe value that is unique
Example: 123456
.... period ∑0..1PeriodTime period when id is/was valid for use
.... assigner ∑0..1Reference(Organization)Organization that issued id (may be just text)
... active ∑0..1booleanWhether this practitioner's record is in active use
... name S ∑0..1HumanNameA name associated with the person
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! ∑0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
.... text ∑0..1stringText representation of the full name
.... family S ∑1..*stringFamily name (often called 'Surname')
.... given S ∑0..2stringGiven names (not always 'first'). Includes middle names
.... prefix S ∑0..1stringParts that come before the name
.... suffix S ∑0..1stringParts that come after the name
.... period ∑0..1PeriodTime period when name was/is in use
... telecom S ∑0..*ContactPointA contact detail for the practitioner
.... us-core-direct S0..1booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/us-core-direct
.... system S ∑I1..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
.... value S ∑1..1stringThe actual contact point details
.... use ?! ∑0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank ∑0..1positiveIntSpecify preferred order of use (1 = highest)
.... period ∑0..1PeriodTime period when the contact point was/is in use
... address ∑0..*AddressWhere practitioner can be found/visited
... gender ∑0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate ∑0..1dateThe date on which the practitioner was born
... photo 0..*AttachmentImage of the person
... practitionerRole S0..*BackboneElementRoles/organizations the practitioner is associated with
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... managingOrganization S0..1Reference(DAF-Organization)Organization where the roles are performed
.... role ∑0..1CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRole (example)
.... specialty ∑0..*CodeableConceptSpecific specialty of the practitioner
Binding: PractitionerSpecialty (example)
.... period ∑0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
.... location 0..*Reference(Location)The location(s) at which this practitioner provides care
.... healthcareService 0..*Reference(HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... qualification 0..*BackboneElementQualifications obtained by training and certification
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... identifier 0..*IdentifierAn identifier for this qualification for the practitioner
.... code 1..1CodeableConceptCoded representation of the qualification
Binding: ANZSCO -- Australian and New Zealand Standard Classification of Occupations, 2013, Version 1.2 (example)
.... period 0..1PeriodPeriod during which the qualification is valid
.... issuer 0..1Reference(Organization)Organization that regulates and issues the qualification
... communication 0..*CodeableConceptA language the practitioner is able to use in patient communication
Binding: IETF BCP-47 (required)

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

D.23.3.1.2 Terminology Bindings

PathNameConformanceValueSet
Practitioner.language?extrequiredhttp://tools.ietf.org/html/bcp47
Practitioner.text.statusNarrativeStatusrequiredNarrativeStatus
Practitioner.identifier.useIdentifierUserequiredIdentifierUse
Practitioner.identifier.typeIdentifier Type CodesextensibleIdentifier Type Codes
Practitioner.name.useNameUserequiredNameUse
Practitioner.telecom.systemContactPointSystemrequiredContactPointSystem
Practitioner.telecom.useContactPointUserequiredContactPointUse
Practitioner.genderAdministrativeGenderrequiredAdministrativeGender
Practitioner.practitionerRole.rolePractitionerRoleexamplePractitionerRole
Practitioner.practitionerRole.specialtyPractitionerSpecialtyexamplePractitionerSpecialty
Practitioner.qualification.codeANZSCO -- Australian and New Zealand Standard Classification of Occupations, 2013, Version 1.2exampleANZSCO -- Australian and New Zealand Standard Classification of Occupations, 2013, Version 1.2
Practitioner.communication?extrequiredhttp://tools.ietf.org/html/bcp47

D.23.3.1.3 Constraints

IdPathDetailsRequirements
inv-1PractitionerShall havePractitioner.name and/or Practitioner.identifier.
XPath: exists(f:name) or exists(f:identifier)
txt-2Practitioner.text.divThe narrative SHALL have some non-whitespace content
XPath: descendant::text()[normalize-space(.)!=''] or descendant::h:img[@src]
txt-1Practitioner.text.divThe narrative SHALL contain only the basic html formatting elements described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
XPath: not(descendant-or-self::*[not(local-name(.)=('a', 'abbr', 'acronym', 'b', 'big', 'blockquote', 'br', 'caption', 'cite', 'code', 'col', 'colgroup', 'dd', 'dfn', 'div', 'dl', 'dt', 'em', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'hr', 'i', 'img', 'li', 'ol', 'p', 'pre', 'q', 'samp', 'small', 'span', 'strong', 'table', 'tbody', 'td', 'tfoot', 'th', 'thead', 'tr', 'tt', 'ul', 'var'))])
txt-3Practitioner.text.divThe narrative SHALL contain only the basic html formatting attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
XPath: not(descendant-or-self::*/@*[not(name(.)=('abbr', 'accesskey', 'align', 'alt', 'axis', 'bgcolor', 'border', 'cellhalign', 'cellpadding', 'cellspacing', 'cellvalign', 'char', 'charoff', 'charset', 'cite', 'class', 'colspan', 'compact', 'coords', 'dir', 'frame', 'headers', 'height', 'href', 'hreflang', 'hspace', 'id', 'lang', 'longdesc', 'name', 'nowrap', 'rel', 'rev', 'rowspan', 'rules', 'scope', 'shape', 'span', 'src', 'start', 'style', 'summary', 'tabindex', 'title', 'type', 'valign', 'value', 'vspace', 'width'))])
.